MacUser Mac Bin 40/MACUSER-MACBIN40A-1997-03.ISO.7z/MACUSER-MACBIN40A-1997-03.ISO/特集⁄オンラインソフト/ゲーム＆アミューズメント/アミューズメント/Citron 1.07J⁄E/収録XCMD説明＆サンプルスタック/XCMD⁄XFCN説明書/Lime説明書

Text File | 1996-11-20 | 20KB | 392 lines

  Lime XCMDは、HyperCard上でQuickTimeムービーを再生し、コントロールするためのXCMDです。
  Lime XCMDは、落合  徹（ちゃい）が著作権を所有しています。自作のスタックなどに利用する場合は、当ドキュメントの「使用上の注意」の項を良く読んでからご使用ください。
  なお、自作のスタック等にインストールする場合は、CitronをHomeスタックへインストールするか、ResEdit等のリソース関連ツールでLime XCMDをコピーしてください。

【Lime XCMD】（Version 1.90      CodeWarrior Gold10使用 1996/11）

  LimeはQuickTimeムービーファイルをHyperCard上で再生するためのXCMDです。

０．更新履歴
（Version 1.90      CodeWarrior Gold10使用 1996/11）
  特製WDEF“FreeFrame”を簡単に使用できるようにするため、ウインドウスタイルにFreeFrame形式を追加

（Version 1.80      CodeWarrior Gold9使用 1996/6）
  Power Macintoshネイティブのバージョンも新たに作成
    ※Power Macintoshバージョンは、ライブラリーの仕様でRateプロパティに小数値が使用できません
  Citron添付用に、名称を今までのMoviePlayからLimeに変更
  その他、マイナーバグフィックス

（Version 1.75      THINK C 5.0.4使用 1994/8）
  マイナー修正バージョン

（Version 1.72      THINK C 5.0.4使用 1994/5）
  255バイト以上のパスに完全対応
  それに伴なってGetFileの機能を拡張した

（Version 1.70      THINK C 5.0.4使用 1994/3）
  オープン時にムービーリソースのID指定ができるように仕様追加

（Version 1.61      THINK C 5.0.4使用 1993/8）
  コールバックメッセージ処理ハンドラー内でコールバック発生元のウインドウをクローズするとシステムエラーを引き起こすバグを修正
  逆転（rateプロパティに負を指定した時）再生がうまく動作しないバグを修正
  ウインドウ名にダブルクォートが含まれていた時のコールバックメッセージの不具合を修正

  コールバックメッセージのメッセージ文字列の最大長を255バイトから63バイトに変更

  ユーザーが用意したWDEFリソースをウインドウ指定に使える様に仕様追加
  同一ウインドウ内でムービーを変更する機能を追加(Movieプロパティ)

（Version 1.00      THINK C 5.0使用 1993/4）
  初回バージョン

１．使用開始および終了

  Limeを使用してムービーを再生する前に、QuickTimeが使えるかどうかを確かめるために一度だけ以下のコマンドを実行することをお勧めします。

    Lime EnterTheater

  QuickTimeが動作可能の状態にあれば以下のメッセージがthe resultに返されます。

    Operation OK. Welcome!

  この際にもしQuickTimeが動作可能の状態（正常に組み込まれた状態）になっていない場合は、以下のエラーがthe resultに返されます。

    Error:QuickTime not installed

  このQuickTimeの組み込み状況は、Lime呼び出し時に毎回チェックされますので、Limeをスクリプト内から呼び出した場合は常にこのエラーが返される可能性がありますが、通常はEnterTheaterコマンドで一度チェックすれば事足りると思われます。

  EnterTheaterに対して、以下のコマンドが用意されています。実際は何もしません。

    Lime ExitTheater

  QuickTimeが動作可能な状態にあれば、以下のメッセージがthe resultに返されます。

    Operation OK. Thank you very mach!

  以上の２コマンドは実行しなくても構いません。しかし、QuickTimeの存在チェックの意味では少なくともEnterTheaterは一度実行しておいた方が良いでしょう。具体的には以下の様にして、スタックオープン／クローズ時に自動的に実行するようにすればいいでしょう。

スタックスクリプトに以下のスクリプトを追加してください（もし、すでに同じハンドラーを別目的で使用している場合には、下記の各ハンドラーの中身の部分を追加してください）。

  on openStack
    Lime EnterTheater
    put the result into rr
    if "Error:" is in rr
    then
      answer "QuickTimeがインストールされていません"
      doMenu "Quit HyperCard"
    end if
    pass openStack
  end openStack

  on closeStack
    Lime ExitTheater --無くても構わない
    pass closeStack
  end closeStack


２．ムービーファイルのフルパスを得る

  Limeには前記の２つの初期化コマンドとは別に、大別して２つのコマンドがあります。
  一つ目は、本XCMDの核となるムービーファイルのオープンコマンド。
  もう一つが、QuickTime登場時にサポートされるようになったPreviewつきのファイルダイアログを使用するコマンドです。

  ファイルダイアログを使用するには以下の書式を使用します。

    Lime GetFileToResult,Movie
  あるいは
    Lime GetFile,Movie

  ファイルダイアログが現われてフォルダーとムービーファイルだけがリストに表示されます。
  GetFileToResultの場合、ファイルを選択すると、変数the resultにそのファイルのフルパスが返されます。
  キャンセルボタンを押した場合には、変数the resultはemptyになり、itに

    Cancel Button selected

  のメッセージが入ります。

  GetFileの場合、ファイルを選択すればHyperTalkのanswer fileコマンドと同じように、変数itにそのファイルのフルパスが返されます(the resultはemptyになります）。
  キャンセルボタンを押した場合には、変数itはemptyになり、the resultに

    Cancel Button selected

  のメッセージが入ります。
  また、GetFileの場合にパスの長さが長すぎる場合、itにそのパスを返すことができません。
  その様な場合は、変数itに

    Warning!! File path strings too long.

  のメッセージが入ります。実際のパスはthe resultに格納されて返されます。

  また、ファイルダイアログが表示できなかったり、パスストリング作成中に問題が発生すると以下の様なメッセージがthe resultに返される時があります。この時は使用を止めて、HyperTalkのAnswer Fileコマンドを使用してください。

    Error:Can't use Stand. Preview routines （スタンダードプレビュールーチンが使用不可）
    Error:No such volume （ありえないパスストリングが作成されようとした）

  以下の引き数を使用することも可能です。

      PICT,Both

    Lime GetFile,PICTの場合はPICTファイルだけがリストアップされます。
    Lime GetFile,Bothの場合はムービーファイルとPICTファイルの両方がリストアップされます。

３．ムービーをオープンする

  ムービーファイルをオープンする場合は以下の書式で行ないます。

    Lime ファイル名,ウインドウ形式,表示位置,表示モード,ﾙｰﾌﾟ,ｺﾝﾄﾛｰﾗｰ, パﾚｯﾄﾌﾗｸﾞ,自動消去,MooV ID
  （ｺﾝﾄﾛｰﾗｰより後は、省略が可能です）

  ・ファイル名はanswer fileや、Lime GetFileで得た、フルパス表記の文字列を与えてください
  ・ウインドウ形式はどんなウインドウで表示するかを指定します
      以下の形式が設定できます















    現在のバージョンではplainとdocumentはまったく同じウインドウが使われますが、将来の拡張で変更がある場合があります（具体的にはGrowBox処理）。通常はdocumentは使用せずに、plainを使用してください。この他、FreeFrame WDEFがスタックにインストールしてあれば、FreeFrameというウインドウ形式が使用できます。このウインドウ形式は、ウインドウの縁を持ちません。
    ウインドウ形式にwdefの文字に続けてウインドウ定義IDを指定する事でユーザーがあらかじめスタックにインストールしておいたWDEFリソースを使用することができます（「wdef」とウインドウ定義IDの数字の間に何も文字を入れないこと）。
        ※ウインドウ定義ID ＝ WDEFリソースID×16＋バリエーション番号
    上記以外の値を指定した場合、存在しないWDEFリソースを指定した場合にはplainが用いられます。

  ・表示位置はムービー表示ウインドウをどの位置に表示するかを、カード上のローカル座標で与えます。
    与え方はウインドウの４点（左上−右下の対角２点で表す矩形）をそのまま指定する方法と、ウインドウの左上の１点を指定する方法が用意されています。
    １点指定の場合は、表示されるムービーに設定された、本来のムービーの大きさでウインドウが作成されます。
    ４点指定の場合は、本来のムービーの大きさとは関係なく、指定した大きさのウインドウが作成され、ムービーはその大きさにあわせて拡大縮小されます。

    どちらの場合も、指定は引用符(")で囲んだ文字列として指定してください。
    例   "0,0"
       "0,0,160,120" など
    また、以下のような方法でも指定できます。
       loc of card button "MovieArea"
       rect of card button "MovieArea"
      この指定で、"MovieArea"というボタンの位置情報をそのまま与えることが可能です。

  ・表示モードは、ムービーファイルオープン時のウインドウの表示状態を指定します。
    以下の値が使用できます。
      Invisible  （オープン時にウインドウは表示しません）
      Visible    （オープン時にウインドウを表示し、先頭フレームを出します）
      Poster     （オープン時にウインドウを表示し、ポスターフレームを出します）
    省略時はVisibleが用いられます。

  ・ﾙｰﾌﾟは初回再生時のループ回数を設定します。
    ０を指定すると、無限ループを行ないます。省略時には１が用いられます。
    一度ループ回数分再生が行なわれた後は、自動的に１がループ回数に設定しなおされます。
    ※後述のムービーコントローラー使用時には、うまくループ回数が有効にならないときがあります。

  ・ｺﾝﾄﾛｰﾗｰはムービーコントローラーをオープン時に付加するかどうかを指定します。
    以下の値が設定できます。
      noController  （付加しない）
      false         （noControllerと同じ）
      true          （付加する）
    省略時はtrueが用いられます。

  以降はオプションパラメーターです。

  ・パﾚｯﾄﾌﾗｸﾞは、ムービーウインドウをHyperCardのパレットレイヤーに置くか置かないかの設定です。
    パレットレイヤーに置くと、常にカードウインドウより手前に表示されます。
    以下の値が設定できます。
      DocumentLayer  （パレットレイヤーに置かずにドキュメントレイヤーに置きます）
      false          （DocumentLayerと同じ）
      true           （パレットレイヤーに置きます）
    省略時はtrueが用いられます。

  ・自動消去は（ループ回数分）ムービー再生が終了した時点で、自動的にウインドウをクローズするかどうかを指定します。
    以下の値が設定できます。
      CloseOnFinish  （再生終了時にウインドウをクローズします）
      true           （CloseOnFinishと同じ）
      false          （再生終了してもウインドウをクローズしません）
    省略時はfalseが用いられます。

  ・MooV IDは、ムービーファイルに複数のムービーが収録されている時、どのIDのMooVリソースを使用するかを数値で指定します。省略時や、0を指定した場合は、一番始めに見つかったMooVリソースを使用します。通常は省略しておけば問題ありません。

  以上のパラメーターを与えることで、ムービーファイルをオープンします。
  ここまでの使用でLime呼び出し時にthe resultに返される可能性のあるエラーメッセージは以下の通りです。

    Error:Missing parameters  （コマンド、パラメーターが一つも指定されていない）
    Error:QuickTime not installed  （前述：QuickTimeが使用不可能）
    Error:This special command is not understand  （指定したコマンドに誤りがある）
    Error:Too few parameters  （パラメーターの数がたりない）
    Error:Empty file name was given  （ファイル名が指定されていない）
    Error:Empty window location was given  （ウインドウの位置が指定されていない）
    Error:Window location parameter syntax error  （ウインドウの位置指定に誤りがある）
    Error:Couldn't open movie file  （ムービーファイルをオープンできなかった）
    Error:Can't active movie file  （無効なムービーファイルである）
    Error:Couldn't create MovieController  （ムービーコントローラーが作成できなかった）
    Error:Couldn't create XWindow  （外部ウインドウが作成できなかった）
    Error:Couldn't allocate storage for window variables  （外部ウインドウ情報を保存するスペースが確保できなかった）


４．ムービーを再生する

  ムービーコントローラーを付加している場合は、他のQuickTimeアプリケーションと同じように、再生や巻き戻しなどがコントローラーで簡単に行なえます。
  付加していない場合、もしくはスクリプト上からコントロールしたい場合は、HyperTalkのsendコマンドを用いて、ムービーウインドウにメッセージを送ってコントロールを行ないます。

send可能なメッセージは以下の通りです。

    show         hide         Play         Stop      Pause
    Mute         MuteOff      MuteToggle
    StepReverse  StepForward  Rewind       Windup
    ShowPoster   CopyFrame    CopyPoster

  show/hideはウインドウの表示／非表示を切り替えます
  Playはそのウインドウのムービーを再生します。
  Stopはムービーを停止させます。メッセージ受付時に再生していたフレームが表示されます。
  Pauseはムービーを一時停止させます。メッセージ受付時に再生していたフレームが表示されます。
    StopとPauseの違いは、その後に実行するPlayメッセージにおいて現われます。Pauseで止めた場合は、そのフレームから再生を開始しますが、Stopの場合は強制的に先頭のフレームに戻って再生を開始します。

  Muteは音をカットし、無音で再生を行ないます。
  MuteOffはMuteを解除して、音つきのムービーを再生します（初期状態）。
  MuteToggleはMuteとMuteOffを交互に切り替えます。
  StepReverseはStepValueプロパティ分、カレントフレームを戻します。
  StepForwardはStepValueプロパティ分、カレントフレームを進めます。
  Rewindは強制的にムービーの先頭フレームに移動します。
  Windupは強制的にムービーの終端フレームに移動します。
  ShowPosterは強制的にポスターフレームに移動し、一時停止状態にします。
  CopyFrameはカレントフレームの画像をクリップボードにコピーします。
  CopyPosterはポスターフレームの画像をクリップボードにコピーします。

５．プロパティ

  ムービーウインドウおよびムービーには以下のプロパティがあります。

    hasController      Loops          CloseOnFinish
    CurrTime           Rate           AudioLevel
    CloseMessage       FinishMessage  MouseDownMessage
    StepValue          Duration
    OriginalRectangle  name           loc    rect    width    height
    visible            Movie

  hasControllerはムービーコントローラーの付加を示します(true/false)
  Loopsは現在の残りループ数を示します。ただし、０の場合は無限ループを示します（整数）
  CloseOnFinishは再生終了時に自動的にウインドウをクローズするかを設定します（整数）
    以上の三つはオープン時に同時設定が可能です。

  CurrTimeは現在表示されているフレームを時間（Movie Time Scale準拠)で得ることができます。再生中のこのプロパティの取得は、タイムラグのために正確な値は得られないと考えておいてください。値を設定すると、カレントフレームが指定した数値に移動します。適当でない数値を与えた場合は範囲内に自動補正されます（整数）
  Rateは再生スピードを示す値です。１が標準の再生、０でストップ、負の値で逆転再生になります。数値の絶対値が多くなるほどスピードがあがります。68Kバージョンでは小数の指定も可能です（数値）
  AudioLevelは再生時の音量を示します。値は０〜２５５です（整数）

  CloseMessage、FinishMessage、MouseDownMessageはそれぞれ、カレントカードにメッセージを送ります。
  CloseMessageはウインドウクローズ時に、FinishMessageは再生が一回終了するごとに、  MouseDownMessageはウインドウ上でマウスをクリックした時に、それぞれ、設定したメッセージを送ります。
  CloseMessageは設定したメッセージに、パラメーターとしてクローズしたウインドウの名称を付加してメッセージを発行します。
  FinishMessageは設定したメッセージに、パラメーターとしてクローズしたウインドウの名称と残りループ回数を付加してメッセージを発行します。
  MouseDownMessageは設定したメッセージに、パラメーターとしてクローズしたウインドウの名称と、クリックしたウインドウ内の座標を文字列として付加してメッセージを発行します
  それぞれのメッセージに空文字列を設定しておくと、そのメッセージは作動しません（６３バイト以内の区切り文字を含まない文字列が設定可能）

  StepValueはsendメッセージのStepReverse、StepForwardで用いる、１ステップのフレーム数を示します。初期値は１です（整数）
  Durationは読み出しのみ可能なプロパティで、ムービーの総時間数（Movie Time Scale準拠)を返します（数値）
  OriginalRectangleは読み出しのみ可能なプロパティで、ムービーに設定されている、本来の大きさをレクタングルの形式で返します（文字列）

  nameはウインドウのタイトルを示します（文字列）
  loc、rect、visible、width、heightはHyperTalkのウインドウプロパティに準じます

  Movieプロパティは設定のみ可能なプロパティです
  ウインドウに設定されているムービーを別のムービーに割り当てなおせます
  パラメーターとしてファイル名を渡します
  ファイル名はanswer fileや、Lime GetFileで得た、フルパス表記を用いてください
  rateやloc、rect、visible等のプロパティは割り当て前のものがそのまま引き継がれます
  ミュート状態は解除されます
  割り当てが成功した場合は、changeMovieメッセージが発行されます
  このプロパティを使用することでムービー切り替え時にいちいち新たなウインドウをオープンすることによる無駄な手間と、ウインドウ作成時のホワイトバックの描画を避けることが可能になります。

６．メッセージコールバック

  Limeは以下の時に、カレントカードに向けて第一パラメーターにウインドウ名を持つメッセージを自動的に送ります。

  ・ムービーファイルオープンに成功したとき、強制的に

            openMovie ウインドウ名

  ・ムービーウインドウをクローズした時
    CloseMessageプロパティ未設定の場合

            closeMovie ウインドウ名

    CloseMessageプロパティにメッセージを設定した場合

            CloseMessageに設定したメッセージ ウインドウ名

  ・ムービーウインドウ内でマウスクリックした時
    かつ、MouseDownMessageプロパティにメッセージが設定されている場合

            MouseDownMessageに設定したメッセージ ウインドウ名,"クリックした座標"

  ・再生がムービーの終わりに達した時
    かつ、FinishMessageプロパティにメッセージが設定されている場合

            FinishMessageで設定したメッセージ ウインドウ名,ループカウンター値

  ・Movieプロパティ設定によるムービーファイル割り当て変更に成功したとき、強制的に

            changeMovie ウインドウ名

  ※カードスクリプトにメッセージを受け取るハンドラーが無い場合は、HyperCardのメッセージ継承パスにそって、メッセージを継承して行きます。
  ※CloseMessage,MouseDownMessage,FinishMessageは、プロパティに空文字列を設定することで、メッセージを発行しなくなります。

７．XCMDバージョン

  以下の方法で、Limeのバージョンを調べることができます。

    Lime XCMDVersion

  the resultによって以下の書式のメッセージが取り出せます。

    Lime XCMD Version *.** by -Chai-
    Lime XCMD PPCVersion *.** by -Chai-      （Power Macintoshバージョンの場合）

  ４ワード目(*.**と表わしたところ）に必ずバージョンナンバーが格納されているので、チェックする場合はそれを対象にしてください。

8．Limeの使用上の注意

 MoviePlay XCMD 1993 (C) Copyright ちゃい=Chai=
 Lime XCMD 1996 (C) Copyright 落合  徹（ちゃい）

  当パッケージを使用してトラブルが起こった際に、本項を読んでいないといった理由は一切受け付けることはできません。内容主旨を理解したうえでご使用ください。

  再配付を行なう様な場合は許可を取ってください（店頭での配付や、他ネットでの配付も含む。有料・無料どちらの場合もお願いします）。
  個人的使用、およびそれに準ずる範囲内を越えた利用の際は、次項の注意をよく理解した上で使用してください。

  当パッケージを使ったことによって生じた直接、間接の損害については、権利者および配付者は一切の責を負わないこととします。あくまで使用者の責任の範囲で運用を行なってください。

9．XCMD/XFCNの使用上の注意

  当XCMD/XFCNの著作権その他の権利は落合  徹（ちゃい）が所有しています。無断で外部使用することを禁じます。この項の説明はstart usingなどで間接的にXCMD/XFCNを使用する場合（Citronでの利用）も、同じ扱いとします。

  Citronの登録ユーザーの方は、個人的使用、およびそれに準ずる範囲内で、自由にご使用ください。
  PDSその他等で配付する場合は以下の通りとなります。いずれの場合も、配布者はCitronの登録ユーザーである必要があります。

  ･フリーウエアに収録して配付の場合は、原則的に無料で許可を出します。
  ･シェアウエアもしくはそれに準ずる形式の配付の場合は（あるいはフリーウエアでも有償にて配付する場合）、XCMD使用料(配付ソフト一種につき￥５０００)をいただきます。
  ･業務目的で使用する場合、利益を生む配付（市販も含む）を行なう場合は別途ご相談ください。XCMD使用料およびライセンス料をいただきます。
 ・収録せずに利用する場合、すなわちstart using等でCitronに収録されたXCMD/XFCNを呼び出す場合は、上３項目に該当しません（つまり、無料ですし、連絡の必要もありません。Citronの登録ユーザーである必要はあります）。ただし、当然ながらXCMD/XFCNを使用するソフト（配布ソフト）のユーザーがCitronの登録ユーザーである必要があります。
 ・当XCMD/XFCNを収録したフリーウエア／シェアウエア（もしくはこれらに準ずる形式の配布形態）を雑誌等の媒体にて配布する場合、シェアウエアもしくはそれに準ずる形式の配付とみなして、配布ソフト作成者あるいは配布者（雑誌等の媒体）より、XCMD使用料(配付ソフト一種につき￥５０００)をいただきます。ただし、シェアウエアもしくはそれに準ずる形式の配付として既にXCMD使用料をいただいている場合は、二重に支払う必要はありません。

  連絡を取る場合は、２日〜１ヵ月の余裕をみておいてください。
  無断使用が発覚した場合、賠償請求させていただくことがあります。

  どの場合もドキュメント等に、以下の項目を記載してください。
  文章スタイル等は変更なさってもかまいません。

・Lime XCMDの著作権その他の権利は落合  徹（ちゃい）（Nifty:QGA01617）が所有しています。
・Lime XCMDを自作スタック等に使用なさりたい場合は、Nifty-Serve FMACHYPよりCitronスタックを入手し、登録した上でご利用ください。
・Lime XCMDを使ったことによって生じた直接、間接の損害については、XCMD作者および配付者は一切の責を負わないこととします。あくまで使用者の責任の範囲で運用を行なってください。
・無断使用が発覚した場合、賠償請求させていただくことがあります。

動作チェック環境
  漢字Talk 7.5.5
  HyperCard 2.3J
  QuickTime 2.5E
  Power Macintosh 8100/80AV,Macintosh LC630,Power Macintosh PowerBook 5300cs

　漢字Talk７以降なら、動作するものと思われます。